Skip to content

Add descriptions and categories to Timeline configurations#1953

Merged
kenzieschmoll merged 2 commits into
flutter:masterfrom
kenzieschmoll:timeline
May 13, 2020
Merged

Add descriptions and categories to Timeline configurations#1953
kenzieschmoll merged 2 commits into
flutter:masterfrom
kenzieschmoll:timeline

Conversation

@kenzieschmoll
Copy link
Copy Markdown
Member

Splits streams into a default and advanced section, and adds some descriptions provided by @rmacnak-google.

Screen Shot 2020-05-12 at 1 01 32 PM

Copy link
Copy Markdown
Contributor

@devoncarew devoncarew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

I'd try to make the descriptions fit in one line where possible (where it does't make them more confusing), and err towards understandability to the user even if the descriptions are slightly less technically correct. Some suggestions below (but please feel free to iterate):

  • Dart: Events emitted from dart:developer Timeline (including Flutter framework events)
  • Embedder: Additional platform events (often emitted from the Flutter engine)
  • GC: Garbage collection
  • API: Calls to the VM embedding API
  • Compiler: Compiler phases (loading code, compilation, optimization, etc.)
  • CompilerVerbose: More detailed compiler phases
  • Debugger: Debugger paused events
  • Isolate: Isolate events (startup, shutdown, snapshot loading, etc.)
  • VM: Dart VM events (startup, shutdown, snapshot loading, etc.)

// the distinction, however.
_buildStream(
name: 'Network',
description: ' • Log Http traffic',
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just Http traffic? or HTTP traffic? Not sure if we need the all caps case

@kenzieschmoll
Copy link
Copy Markdown
Member Author

Incorporated suggestions and expanded the width of the dialog to make items fit on one line:
Screen Shot 2020-05-13 at 8 31 30 AM

@kenzieschmoll kenzieschmoll merged commit 0cfb0c2 into flutter:master May 13, 2020
@kenzieschmoll kenzieschmoll deleted the timeline branch May 13, 2020 16:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants